home *** CD-ROM | disk | FTP | other *** search
/ PC-SIG Library 8 / PC-SIG Library CD-ROM (8th Edition) (1990-04).iso / 201_300 / disk0254 / help.doc < prev    next >
Encoding:
Text File  |  1984-09-05  |  11.3 KB  |  239 lines
  1.                   PC-DOS 2.00 & 2.10 HELP Function
  2.                   --------------------------------
  3.  
  4. Copyright (C) 1984 by:  Chris Bailey
  5.                         P.O. Box 332
  6.                         Peterborough, Ontario
  7.                         Canada, K9J 6Z3
  8.  
  9.  
  10.                        Distribution Notice
  11.  
  12. The HELP function is made available as a User-Supported "public
  13. domain" package consisting of the program, help and document
  14. files listed below.  You are encouraged to give copies to your
  15. friends for evaluation, however only complete "distribution
  16. copies" should be made using the batch file MAKEBKUP.BAT provided
  17. on the diskette.  Please do not distribute altered copies.  The
  18. package MUST NOT be sold by retailers.  If after a short
  19. evaluation period you find this HELP function is of value to you,
  20. please register your copy with me using the HELPREG.DOC file on
  21. this diskette and include a recommended contribution of $15.  (If
  22. you obtained this diskette directly from me, the $10 charged is
  23. used to cover the cost of materials, postage and handling)  This
  24. $15 contribution helps me continue software development and
  25. provide you with new and interesting software products at
  26. reasonable prices.  You will also be informed of updates and new
  27. software packages as they become available if you register. 
  28. Additional copies of this package are available on request for
  29. $25 ($10 for handling & $15 contribution).
  30.  
  31. Businesses, schools and other facilities that wish to make many
  32. copies of this package or put the package on a network may obtain
  33. site licence privileges by paying a fee based on the following
  34. calculation:
  35.          $15  - for the first copy of the package;
  36.     plus $5   - for each additional copy made, or each computer
  37.                 or terminal accessing the package via a network
  38.                 (up to a maximum total of $200).
  39.  
  40.      or  $200 - to obtain unlimited copying and network access
  41.                 privileges at the site.
  42.  
  43. To continue developing software that is affordable I require a
  44. certain monetary return on this product.  This package is better
  45. than most computer aids available today, and has been distributed
  46. through the public domain to keep the marketing, packaging and
  47. distribution costs down.  These benefits have been passed on to
  48. you the user by allowing you to "try before you buy" and
  49. utimately asking for a modest $15 contribution (what other
  50. software can you get for $15 ?).  In the true spirit of
  51. User-Supported software, you the user must support the product in
  52. a monetary manner if you use it (otherwise it's called software
  53. piracy).  The alternative is to not pay and discourage software
  54. authors from using the public domain as a distribution method. 
  55. This will only help drive up the cost of software in general.
  56.  
  57. This package is distributed on an "as is" basis without warranty.
  58. Every attempt has been made to ensure the accuracy of the text
  59. and examples included in the help files, however the package is
  60. intended as a supplement to your copy of the DOS manual, not a
  61. replacement.  If contradictions arise between the DOS manual and
  62. the HELP files, the DOS manual must prevail.
  63.  
  64.  
  65.  
  66.               HELP Function Files on this Diskette
  67.  
  68. The following files and directories should be present on your
  69. copy of the distribution diskette:
  70.   HELP.EXE     - The HELP Function program.
  71.   HCONFIG.EXE  - HELP Function configuration program.
  72.   HELP.DOC     - This file.
  73.   HELPREG.DOC  - HELP Function registration form.
  74.   MAKEBKUP.BAT - Make a backup of this disk.
  75.   CNV2_00.BAT  - Convert the HELP files for DOS version 2.00.
  76.   CNVPCJR.BAT  - Convert the HELP files for use with PCjr.
  77.   CLEANUP.BAT  - Delete extra files to free up disk space after
  78.                   the HELP Function is configured for your system.
  79.   \PRIMARY     - All primary help files (50 files).
  80.   \SECNDRY     - All secondary help files (58 files).
  81.   \HELP2_00\PRIMARY - DOS 2.00 primary help file changes (2 files).
  82.            \SECNDRY - DOS 2.00 secondary help file changes (7 files).
  83.   \HELPPCJR\PRIMARY - PCjr primary help file changes (9 files).
  84.            \SECNDRY - PCjr secondary help file changes (12 files).
  85.  
  86.  
  87.                   Computer Required to Use HELP
  88.  
  89. To successfully use the HELP function, you will require the
  90. following computer system:
  91.  
  92.         IBM Personal Computer, PCjr, or a compatible machine
  93.         One or more diskette drives
  94.         80 column color/graphics or monochrome display
  95.         PC-DOS 2.00 or 2.10
  96.  
  97.  
  98.                    HELP Function Capabilities
  99.  
  100. The HELP function provides an on-screen help capability that
  101. should helpful for anyone using PC-DOS 2.00 or 2.10.  As
  102. distributed this package contains two levels of help for all DOS
  103. commands, an abbreviated version and a detailed explanation
  104. including examples.  In addition, many topics not normally
  105. discussed are explained at length in the secondary help files.
  106. Solutions to common computer problems and clarifications of some
  107. DOS concepts are also addressed.
  108.  
  109. To invoke the HELP function, enter the command "HELP" followed by
  110. the Enter key.  This will show you the topics available at the
  111. primary help level.  To view the help file, enter the command
  112. "HELP" followed by a space followed by the topic of interest
  113. followed by the Enter key.  The secondary help level is accessed
  114. in a similar manner by entering "HELP /S" to see the topics
  115. available, and "HELP topic/S" to view the secondary help file on
  116. this topic (note there is no space between the topic and the
  117. "/S" in the command).
  118.  
  119.  
  120.               Backing Up Your Distribution Diskette
  121.  
  122. Before using or altering this HELP function distribution diskette
  123. a backup copy should be made.  You may do this using your
  124. favorite method or by invoking the batch file MAKEBKUP.BAT
  125. included on the distribution diskette.  If your computer has only
  126. one disk drive, the files DISKCOPY and DISKCOMP must be copied
  127. from your DOS diskette to this diskette before running the batch
  128. file.  Place a write protect tab over the notch on the side of
  129. your diskette before backing up.  Invoke the batch file by
  130. entering the command "MAKEBKUP p: s: d:" followed by the Enter
  131. key. In the command you should replace "p:" with the drive
  132. containing the DOS programs DISKCOPY and DISKCOMP in the default
  133. directory, "s:" with the diskette drive containing the
  134. distribution diskette, and "d:" with the destination disk drive
  135. to write the copy.  The destination diskette must be formatted
  136. before starting this batch file.
  137.  
  138. Examples:
  139. * To backup using a single drive system, the command would be
  140. entered as "MAKEBKUP A: A: A:".  DOS will prompt for the source
  141. and destination diskettes at the appropriate times and may
  142. require the insertion of a system diskette a couple of times. 
  143.  
  144. * To backup in a dual drive system, the command is entered as
  145. "MAKEBKUP A: B: B:" to do a single drive copy in drive B: while
  146. leaving the DOS diskette in drive A:
  147.  
  148.  
  149.          Configuring the HELP Function for Your Computer
  150.  
  151. There are several things that must be done to prepare the HELP
  152. function for your computer.  As supplied, the HELP function
  153. describes the commands for PC-DOS version 2.10.  If you are using
  154. DOS 2.00, submit the batch file CNV2_00.BAT to convert the help
  155. files to explain DOS 2.00 (make sure you have a backup copy of
  156. the HELP distribution diskette before doing this).  To submit the
  157. file, put your diskette copy in the default diskette drive and
  158. enter the command "CNV2_00" followed by the Enter key.
  159.  
  160. If you are using a PCjr, you will be running DOS 2.10.  The keys
  161. on the PCjr keyboard are different, so there is a batch file
  162. CNVPCJR.BAT to convert the help files to reference those keys.
  163. Submit the batch file by putting your distribution diskette in
  164. the default diskette drive and entering the command "CNVPCJR"
  165. followed by the Enter key.  If you only have one disk drive, that
  166. drive is the default.  Make sure you have a backup copy of the
  167. HELP distribution diskette before doing this.
  168.  
  169. You must decide which disk is to contain the help function.  It
  170. might be easiest to keep your HELP distribution diskette as a
  171. dedicated help diskette.  Another alternative is to copy the file
  172. HELP.EXE to your DOS system diskette and leave the help files on
  173. the distribution diskette in drive B:.  For those of you with a
  174. fixed disk, you might be able to put all the primary and
  175. secondary help files on your fixed disk.  The choice is up to
  176. you, however you should perform the next step before actually
  177. copying any files to other disks (aside from your backup).
  178.  
  179.  
  180.  
  181. A program named HCONFIG.EXE is supplied on the distribution
  182. diskette to allow you to configure the HELP function for your
  183. system.  This allows you to specify the directories, disk drives
  184. and filename extensions that HELP.EXE should use when responding
  185. to primary and secondary help requests.  To run the program,
  186. enter "HCONFIG" followed by the Enter key.  Both HELP.EXE and
  187. HCONFIG.EXE must be in the default diskette drive and directory.
  188.  
  189. When HELP.EXE is configured, copy the help files and HELP.EXE to
  190. the directories you have decided upon and try obtaining some
  191. help.  If help is not displayed as expected, you have probably
  192. done something wrong while using HCONFIG, so rerun that program
  193. and check for errors.  After fixing the specifications, copy
  194. HELP.EXE to your selected disk again and retest it.
  195.  
  196. If you have decided to use this copy of your distribution
  197. diskette as a dedicated HELP diskette, you can free up some space
  198. by running the batch file CLEANUP.BAT.  This will delete all the
  199. help files you will not need after configuring for your system.
  200. You should only run this after converting to DOS 2.00 or PCjr (if
  201. desired).  The file is submitted by entering "CLEANUP" followed
  202. by the Enter key.
  203.  
  204.  
  205.                      Adding New Help Topics
  206.  
  207. If you view the subdirectories \PRIMARY and \SECNDRY on the
  208. distribution diskette with the DIR command, you will see that
  209. each topic available for help is a file with the same name and
  210. the extension ".HLP".  This makes it easy for you to add new help
  211. topics to the diskette.  One of the best uses I have found is to
  212. keep track of programs I have written.  Once a program is written
  213. and tested, a short help file of the same name is created so that
  214. in six month's time I can figure out what that program is
  215. supposed to do.  Each help file should be entered as an ASCII
  216. file (non-document mode for those of you with Wordstar) so it
  217. will display correctly on the screen, and must be under 64 Kbytes
  218. in length.  In addition, the help filenames should not contain
  219. the characters =+[];: or " .
  220.  
  221. Give a copy of HELP to your friends, and encourage them to make a
  222. $15 contribution as well (that's the whole idea behind
  223. User-Supported software; it's supported by the users)!  PLEASE
  224. make all copies from your original distribution diskette.  I
  225. really don't want to get many different versions of the help
  226. files circulating.  If you have new examples for the DOS help
  227. files or disagree with my interpretations please let me know so
  228. the problems can be corrected in future releases.  There is one
  229. exception though; a special file named ADDENDUM.HLP in the
  230. secondary help files where you are invited to make additions that
  231. might aid others in their understanding and interpretation of
  232. PC-DOS.
  233.  
  234.  
  235.  
  236.  
  237. IBM PC, XT, PCjr & PC-DOS are registered trademarks of International
  238. Business Machines.
  239.